home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / gindxbib.1 < prev    next >
Text File  |  1995-07-25  |  6KB  |  133 lines
  1.  
  2.  
  3.  
  4.      GGGGIIIINNNNDDDDXXXXBBBBIIIIBBBB((((1111))))   GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444))))   GGGGIIIINNNNDDDDXXXXBBBBIIIIBBBB((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           gindxbib - make inverted index for bibliographic databases
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ggggiiiinnnnddddxxxxbbbbiiiibbbb [ ----vvvvwwww ] [ ----cccc_f_i_l_e ] [ ----dddd_d_i_r ] [ ----ffff_f_i_l_e ] [ ----hhhh_n ]
  13.                    [ ----iiii_s_t_r_i_n_g ] [ ----kkkk_n ] [ ----llll_n ] [ ----nnnn_n ] [ ----oooo_f_i_l_e ]
  14.                    [ ----tttt_n ] [ _f_i_l_e_n_a_m_e... ]
  15.  
  16.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.           ggggiiiinnnnddddxxxxbbbbiiiibbbb makes an inverted index for the bibliographic
  18.           databases in _f_i_l_e_n_a_m_e...  for use with ggggrrrreeeeffffeeeerrrr(1),
  19.           ggggllllooooooookkkkbbbbiiiibbbb(1), and llllkkkkbbbbiiiibbbb(1).  The index will be named
  20.           _f_i_l_e_n_a_m_e....iiii; the index is written to a temporary file which
  21.           is then renamed to this.  If no filenames are given on the
  22.           command line because the ----ffff option has been used, and no ----oooo
  23.           option is given, the index will be named IIIInnnndddd....iiii.
  24.  
  25.           Bibliographic databases are divided into records by blank
  26.           lines.  Within a record, each fields starts with a %%%%
  27.           character at the beginning of a line.  Fields have a one
  28.           letter name which follows the %%%% character.
  29.  
  30.           The values set by the ----cccc, ----nnnn, ----llll and ----tttt options are stored
  31.           in the index; when the index is searched, keys will be
  32.           discarded and truncated in a manner appropriate to these
  33.           options; the original keys will be used for verifying that
  34.           any record found using the index actually contains the keys.
  35.           This means that a user of an index need not know whether
  36.           these options were used in the creation of the index,
  37.           provided that not all the keys to be searched for would have
  38.           been discarded during indexing and that the user supplies at
  39.           least the part of each key that would have remained after
  40.           being truncated during indexing.  The value set by the ----iiii
  41.           option is also stored in the index and will be used in
  42.           verifying records found using the index.
  43.  
  44.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  45.           ----vvvv   Print the version number.
  46.  
  47.           ----wwww   Index whole files.  Each file is a separate record.
  48.  
  49.           ----cccc_f_i_l_e
  50.                Read the list of common words from _f_i_l_e instead of
  51.                ////uuuussssrrrr////llllooooccccaaaallll////lllliiiibbbb////ggggrrrrooooffffffff////eeeeiiiiggggnnnn.
  52.  
  53.           ----dddd_d_i_r
  54.                Use _d_i_r as the pathname of the current working
  55.                directory to store in the index, instead of the path
  56.                printed by ppppwwwwdddd(1).  Usually _d_i_r will be a symbolic link
  57.                that points to the directory printed by ppppwwwwdddd(1).
  58.  
  59.           ----ffff_f_i_l_e
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 3/9/94)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      GGGGIIIINNNNDDDDXXXXBBBBIIIIBBBB((((1111))))   GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444))))   GGGGIIIINNNNDDDDXXXXBBBBIIIIBBBB((((1111))))
  71.  
  72.  
  73.  
  74.                Read the files to be indexed from _f_i_l_e.  If _f_i_l_e is ----,
  75.                files will be read from the standard input.  The ----ffff
  76.                option can be given at most once.
  77.  
  78.           ----iiii_s_t_r_i_n_g
  79.                Don't index the contents of fields whose names are in
  80.                _s_t_r_i_n_g.  Initially _s_t_r_i_n_g is XXXXYYYYZZZZ.
  81.  
  82.           ----hhhh_n  Use the first prime greater than or equal to _n for the
  83.                size of the hash table.  Larger values of _n will
  84.                usually make searching faster, but will make the index
  85.                larger and ggggiiiinnnnddddxxxxbbbbiiiibbbb use more memory.  Initially _n is
  86.                997.
  87.  
  88.           ----kkkk_n  Use at most _n keys per input record.  Initially _n is
  89.                100.
  90.  
  91.           ----llll_n  Discard keys that are shorter than _n.  Initially _n is
  92.                3.
  93.  
  94.           ----nnnn_n  Discard the _n most common words.  Initially _n is 100.
  95.  
  96.           ----oooo_b_a_s_e_n_a_m_e
  97.                The index should be named _b_a_s_e_n_a_m_e....iiii.
  98.  
  99.           ----tttt_n  Truncate keys to _n.  Initially _n is 6.
  100.  
  101.      FFFFIIIILLLLEEEESSSS
  102.           _f_i_l_e_n_a_m_e....iiii     Index.
  103.  
  104.           IIIInnnndddd....iiii          Default index name.
  105.  
  106.           ////uuuussssrrrr////llllooooccccaaaallll////lllliiiibbbb////ggggrrrrooooffffffff////eeeeiiiiggggnnnn
  107.                          List of common words.
  108.  
  109.           iiiinnnnddddxxxxbbbbiiiibbbb_X_X_X_X_X_X  Temporary file.
  110.  
  111.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  112.           ggggrrrreeeeffffeeeerrrr(1), llllkkkkbbbbiiiibbbb(1), ggggllllooooooookkkkbbbbiiiibbbb(1)
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 3/9/94)
  130.  
  131.  
  132.  
  133.